docs

2001-02-17  Havoc Pennington  <hp@pobox.com>

	* gdk-pixbuf-loader.c (gdk_pixbuf_loader_new_with_type): docs

diff --git a/gdk-pixbuf/ChangeLog b/gdk-pixbuf/ChangeLog
index 4b1d13dc4d1fdfea62212a4d4eaa906e966debf7..c33eb753256fe183c90e693981c09d30dea12741 100644 (file)
--- a/gdk-pixbuf/ChangeLog
+++ b/gdk-pixbuf/ChangeLog
@@ -1,3 +1,7 @@
+2001-02-17  Havoc Pennington  <hp@pobox.com>
+
+       * gdk-pixbuf-loader.c (gdk_pixbuf_loader_new_with_type): docs
+
 2001-02-07  Alexander Larsson  <alexl@redhat.com>
 
        * io-xpm.c (free_buffer):

diff --git a/gdk-pixbuf/gdk-pixbuf-loader.c b/gdk-pixbuf/gdk-pixbuf-loader.c
index 3ed90367828ae8d7d78a6fcc2a2fb66d6f07e44f..45bd4cf4cf9a86242c7313fe04d11adca7d989b8 100644 (file)
--- a/gdk-pixbuf/gdk-pixbuf-loader.c
+++ b/gdk-pixbuf/gdk-pixbuf-loader.c
@@ -498,8 +498,15 @@ gdk_pixbuf_loader_new (void)
 
 /**
  * gdk_pixbuf_loader_new_with_type:
+ * @image_type: name of the image format to be loaded with the image
+ * @error: return location for an allocated #GError, or %NULL to ignore errors
  *
- * Creates a new pixbuf loader object.
+ * Creates a new pixbuf loader object that always attempts to parse
+ * image data as if it were an image of type @image_type, instead of
+ * identifying the type automatically. Useful if you want an error if
+ * the image isn't the expected type, for loading image formats
+ * that can't be reliably identified by looking at the data, or if
+ * the user manually forces a specific type.
  *
  * Return value: A newly-created pixbuf loader.
  **/